/*
 * Copyright 2008 Jens Meiss
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.hmvc4gwt.hmvc.gwt.framework.client.controller;

import java.util.Map;

import com.google.gwt.user.client.History;
import com.google.gwt.user.client.HistoryListener;
import com.googlecode.hmvc4gwt.hmvc.core.controller.AController;
import com.googlecode.hmvc4gwt.hmvc.core.event.IEvent;
import com.googlecode.hmvc4gwt.hmvc.core.event.IEventListener;

/**
 * A HistoryController is automatically registered (and unregistered) at the History and controls a
 * set of History-Token to navigate to. You can create a lot of
 * HistoryController, every responsible for a special set of Tokens.
 * 
 * @author jens.meiss
 */
public abstract class AControllerHistoryGwt extends AController implements
		HistoryListener {

	public final void handleEvent(IEvent event) {
		handleEventImpl(event);
	}

	/**
	 * This method is called after handleEvent() and has the same purpose
	 * 
	 * @param event
	 */
	public abstract void handleEventImpl(IEvent event);

	public final void init() {

		History.addHistoryListener(this);

		initImpl();
	}

	/**
	 * This method is called after init() an has the same purpose
	 */
	public abstract void initImpl();

	public final void registerEventListener(
			Map<Class<? extends IEvent>, IEventListener> mapEventListener) {

		registerEventListenerImpl(mapEventListener);
	}

	/**
	 * This method is called after registerEventListener() an has the same
	 * purpose
	 * 
	 * @param mapEventListener
	 */
	public abstract void registerEventListenerImpl(
			Map<Class<? extends IEvent>, IEventListener> mapEventListener);

	public final void terminate() {

		History.removeHistoryListener(this);

		terminateImpl();
	}

	/**
	 * This method is called after init() an has the same purpose
	 */
	public abstract void terminateImpl();
}
